﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<link rel="Stylesheet" type="text/css" media="screen" href="Screen.css" />
  <title>STP_GetMstConfigTable</title>
</head>
<body>
	<h3>STP_GetMstConfigTable</h3>
	<hr />
<pre>
const struct STP_CONFIG_TABLE_ENTRY* STP_GetMstConfigTable
(
    const STP_BRIDGE*  bridge,
    unsigned int*      entryCountOut
);
</pre>
	<h4>
		Summary</h4>
	<p>
		Retrieves a pointer to the MST configuration table (the VLAN to tree mapping).</p>
	<h4>
		Parameters</h4>
	<dl>
		<dt>bridge</dt>
		<dd>Pointer to an STP_BRIDGE object.</dd>
		<dt>entryCountOut</dt>
        <dd>Pointer to a variable where this function writes the number
            of entries available. This is <code>maxVlanNumber + 1</code>,
            where <code>maxVlanNumber</code> is the parameter that was
            passed to <a href="STP_CreateBridge.html">STP_CreateBridge</a>.</dd>
    </dl>
	<h4>
		Return Value</h4>
    <p>
		The function returns a pointer to the table kept internally by the library.</p>
    <h4>
		Remarks</h4>
		<p>
			You can call this function even when the bridge is not running MSTP.</p>
		<p>
			Element at index 0 of the table is unused and contains the value 0. Element at index 1 corresponds to VLAN 1, element at index 1 corresponds to VLAN 2 and so on. The table can contain up to 4096 elements.</p>
	<p>
		See §13.8 in 802.1Q-2018 for more information about the MST Configuration Identifier.</p>
	<p>
		It is allowed to call this function from within an <a href="STP_CALLBACKS.html">STP callback</a>.</p>
    <p>
		See also <a href="STP_SetMstConfigTable.html">STP_SetMstConfigTable</a>.</p>

</body>
</html>
